在Springboot中,推荐使用properties或者YAML文件来完成配置,但是对于较复杂的数据结构来说,YAML又远远优于properties。本文就快速介绍YAML的常见语法格式。
先来看一个Springboot中的properties文件和对应YAML文件的对比:
#properties格式: |
#YAML格式 |
可以直观的看到,YAML使用冒号加缩进的方式代表层级(属性)关系,使用短横杠(-)代表数组元素,在处理层级关系的时候,YAML格式文件就简单很多。
快速入门
下面立刻展示YAML最基本,最常用的一些使用格式:
首先YAML中允许表示三种格式,分别是常量值,对象和数组
例如:
#即表示url属性值; |
注释:
和properties相同,使用#作为注释,YAML中只有行注释。
基本格式要求
- YAML大小写敏感;
- 使用缩进代表层级关系;
- 缩进只能使用空格,不能使用TAB,不要求空格个数,只需要相同层级左对齐(一般2个或4个空格)
对象:
使用冒号代表,格式为key: value。冒号后面要加一个空格:
key: value |
可以使用缩进表示层级关系;
key: |
YAML中还支持流式(flow)语法表示对象,比如上面例子可以写为:
key: {child-key: value, child-key2: value2} |
较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的key,配合一个冒号加一个空格代表一个value:
? |
意思即对象的属性是一个数组[complexkey1,complexkey2],对应的值也是一个数组[complexvalue1,complexvalue2]
数组:
使用一个短横线加一个空格代表一个数组项:
hobby: |
当然也可以有这样的写法:
- |
可以简单理解为:[[Java,LOL]]
一个相对复杂的例子:
companies: |
意思是companies属性是一个数组,每一个数组元素又是由id,name,price三个属性构成;
数组也可以使用流式(flow)的方式表示:
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}] |
常量:
YAML中提供了多种常量结构,包括:整数,浮点数,字符串,NULL,日期,布尔,时间。下面使用一个例子来快速了解常量的基本使用:
boolean: |
一些特殊符号:
YAML中提供了很多特殊符号,在这里简单介绍常用的一些:
1,— YAML可以在同一个文件中,使用—表示一个文档的开始;比如Springboot中profile的定义:
server: |
代表定义了两个profile,一个是development,一个production;也常常使用—来分割不同的内容,比如记录日志:
--- |
和—配合使用,在一个配置文件中代表一个文件的结束:
--- |
相当于在一个yaml文件中连续写了两个yaml配置项。
!! YAML中使用!!做类型强行转换:
string: |
相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多,比如:
--- !!set |
将数组解析为set,简单理解,转化的内容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}],重复的Sammy Sosa去掉;
在字符串中折叠换行,| 保留换行符,这两个符号是YAML中字符串经常使用的符号,比如:
accomplishment: > |
那么结果是:
stats=65 Home Runs |
即| 符号保留了换行符,而accomplishment的结果为:
accomplishment=Mark set a major league home run record in 1998. |
即将换行符转化成了空格;要注意一点的是,每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段:
phraseTemplate: | |
5,引用。重复的内容在YAML中可以使用&来完成锚点定义,使用*来完成锚点引用,例如:
hr: |
可以看到,在hr中,使用&SS为Sammy Sosa设置了一个锚点(引用),名称为SS,在rbi中,使用*SS完成了锚点使用,那么结果为:
{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]} |
我们也可以这样定义:
SS: &SS Sammy Sosa |
注意,不能独立的定义锚点,比如不能直接这样写: &SS Sammy Sosa;另外,锚点能够定义更复杂的内容,比如:
default: &default |
那么hr相当于引用了default的数组,注意,hr: *default要写在同一行。
参考:
JS-YAML在线示例:http://nodeca.github.io/js-yaml/
https://www.jianshu.com/p/97222440cd08